IRIX Base Documentation 2002 November/SGI IRIX Base Documentation 2002 November.iso/usr/share/catman/u_man/cat1/pod2man.z/pod2man

Text File | 2002-10-03 | 10.7 KB | 331 lines

PPPPOOOODDDD2222MMMMAAAANNNN((((1111))))                                                          PPPPOOOODDDD2222MMMMAAAANNNN((((1111))))



NNNNAAAAMMMMEEEE
     pod2man - translate embedded Perl pod directives into man pages

SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
     ppppoooodddd2222mmmmaaaannnn [ --------sssseeeeccccttttiiiioooonnnn====_m_a_n_e_x_t ] [ --------rrrreeeelllleeeeaaaasssseeee====_r_e_l_p_a_t_c_h ] [ --------cccceeeennnntttteeeerrrr====_s_t_r_i_n_g ] [
     --------ddddaaaatttteeee====_s_t_r_i_n_g ] [ --------ffffiiiixxxxeeeedddd====_f_o_n_t ] [ --------ooooffffffffiiiicccciiiiaaaallll ] [ --------llllaaaaxxxx ] _i_n_p_u_t_f_i_l_e

DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     ppppoooodddd2222mmmmaaaannnn converts its input file containing embedded pod directives (see
     the _p_e_r_l_p_o_d manpage) into nroff source suitable for viewing with _n_r_o_f_f(1)
     or _t_r_o_f_f(1) using the _m_a_n(7) macro set.

     Besides the obvious pod conversions, ppppoooodddd2222mmmmaaaannnn also takes care of _f_u_n_c(),
     _f_u_n_c(n), and simple variable references like $foo or @bar so you don't
     have to use code escapes for them; complex expressions like
     $fred{'stuff'} will still need to be escaped, though.  Other nagging
     little roffish things that it catches include translating the minus in
     something like foo-bar, making a long dash--like this--into a real em
     dash, fixing up "paired quotes", putting a little space after the parens
     in something like _f_u_n_c(), making C++ and pi look right, making double
     underbars have a little tiny space between them, making ALLCAPS a teeny
     bit smaller in _t_r_o_f_f(1), and escaping backslashes so you don't have to.

OOOOPPPPTTTTIIIIOOOONNNNSSSS
     center  Set the centered header to a specific string.  The default is
             "User Contributed Perl Documentation", unless the --official flag
             is given, in which case the default is "Perl Programmers
             Reference Guide".

     date    Set the left-hand footer string to this value.  By default, the
             modification date of the input file will be used.

     fixed   The fixed font to use for code refs.  Defaults to CW.

     official
             Set the default header to indicate that this page is of the
             standard release in case --center is not given.

     release Set the centered footer.  By default, this is the current perl
             release.

     section Set the section for the .TH macro.  The standard conventions on
             sections are to use 1 for user commands,  2 for system calls, 3
             for functions, 4 for devices, 5 for file formats, 6 for games, 7
             for miscellaneous information, and 8 for administrator commands.
             This works best if you put your Perl man pages in a separate
             tree, like /_u_s_r/_l_o_c_a_l/_p_e_r_l/_m_a_n/.  By default, section 1 will be
             used unless the file ends in ._p_m in which case section 3 will be
             selected.






                                                                        PPPPaaaaggggeeee 1111






PPPPOOOODDDD2222MMMMAAAANNNN((((1111))))                                                          PPPPOOOODDDD2222MMMMAAAANNNN((((1111))))



     lax     Don't complain when required sections aren't present.

AAAAnnnnaaaattttoooommmmyyyy ooooffff aaaa PPPPrrrrooooppppeeeerrrr MMMMaaaannnn PPPPaaaaggggeeee
     For those not sure of the proper layout of a man page, here's an example
     of the skeleton of a proper man page.  Head of the major headers should
     be setout as a =head1 directive, and are historically written in the
     rather startling ALL UPPER CASE format, although this is not mandatory.
     Minor headers may be included using =head2, and are typically in mixed
     case.

     NAME      Mandatory section; should be a comma-separated list of programs
               or functions documented by this podpage, such as:

                   foo, bar - programs to do something


     SYNOPSIS  A short usage summary for programs and functions, which may
               someday be deemed mandatory.

     DESCRIPTION
               Long drawn out discussion of the program.  It's a good idea to
               break this up into subsections using the =head2 directives,
               like

                   =head2 A Sample Subection

                   =head2 Yet Another Sample Subection


     OPTIONS   Some people make this separate from the description.

     RETURN VALUE
               What the program or function returns if successful.

     ERRORS    Exceptions, return codes, exit stati, and errno settings.

     EXAMPLES  Give some example uses of the program.

     ENVIRONMENT
               Envariables this program might care about.

     FILES     All files used by the program.  You should probably use the F<>
               for these.

     SEE ALSO  Other man pages to check out, like _m_a_n(1), _m_a_n(7),
               _m_a_k_e_w_h_a_t_i_s(8), or _c_a_t_m_a_n(8).

     NOTES     Miscellaneous commentary.

     CAVEATS   Things to take special care with; sometimes called WARNINGS.





                                                                        PPPPaaaaggggeeee 2222






PPPPOOOODDDD2222MMMMAAAANNNN((((1111))))                                                          PPPPOOOODDDD2222MMMMAAAANNNN((((1111))))



     DIAGNOSTICS
               All possible messages the program can print out--and what they
               mean.

     BUGS      Things that are broken or just don't work quite right.

     RESTRICTIONS
               Bugs you don't plan to fix :-)

     AUTHOR    Who wrote it (or AUTHORS if multiple).

     HISTORY   Programs derived from other sources sometimes have this, or you
               might keep a modification log here.

EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS
         pod2man program > program.1
         pod2man some_module.pm > /usr/perl/man/man3/some_module.3
         pod2man --section=7 note.pod > note.7


DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
     The following diagnostics are generated by ppppoooodddd2222mmmmaaaannnn.  Items marked "(W)"
     are non-fatal, whereas the "(F)" errors will cause ppppoooodddd2222mmmmaaaannnn to immediately
     exit with a non-zero status.

     bad option in paragraph %d of %s: ``%s'' should be [%s]<%s>
         (W) If you start include an option, you should set it off as bold,
         italic, or code.

     can't open %s: %s
         (F) The input file wasn't available for the given reason.

     Improper man page - no dash in NAME header in paragraph %d of %s
         (W) The NAME header did not have an isolated dash in it.  This is
         considered important.

     Invalid man page - no NAME line in %s
         (F) You did not include a NAME header, which is essential.

     roff font should be 1 or 2 chars, not `%s'  (F)
         (F) The font specified with the --fixed option was not a one- or
         two-digit roff font.

     %s is missing required section: %s
         (W) Required sections include NAME, DESCRIPTION, and if you're using
         a section starting with a 3, also a SYNOPSIS.  Actually, not having a
         NAME is a fatal.

     Unknown escape: %s in %s
         (W) An unknown HTML entity (probably for an 8-bit character) was
         given via a E<> directive.  Besides amp, lt, gt, and quot, recognized
         entities are Aacute, aacute, Acirc, acirc, AElig, aelig, Agrave,



                                                                        PPPPaaaaggggeeee 3333






PPPPOOOODDDD2222MMMMAAAANNNN((((1111))))                                                          PPPPOOOODDDD2222MMMMAAAANNNN((((1111))))



         agrave, Aring, aring, Atilde, atilde, Auml, auml, Ccedil, ccedil,
         Eacute, eacute, Ecirc, ecirc, Egrave, egrave, ETH, eth, Euml, euml,
         Iacute, iacute, Icirc, icirc, Igrave, igrave, Iuml, iuml, Ntilde,
         ntilde, Oacute, oacute, Ocirc, ocirc, Ograve, ograve, Oslash, oslash,
         Otilde, otilde, Ouml, ouml, szlig, THORN, thorn, Uacute, uacute,
         Ucirc, ucirc, Ugrave, ugrave, Uuml, uuml, Yacute, yacute, and yuml.

     Unmatched =back
         (W) You have a =back without a corresponding =over.

     Unrecognized pod directive: %s
         (W) You specified a pod directive that isn't in the known list of
         =head1, =head2, =item, =over, =back, or =cut.

NNNNOOOOTTTTEEEESSSS
     If you would like to print out a lot of man page continuously, you
     probably want to set the C and D registers to set contiguous page
     numbering and even/odd paging, at least on some versions of _m_a_n(7).
     Settting the F register will get you some additional experimental
     indexing:

         troff -man -rC1 -rD1 -rF1 perl.1 perldata.1 perlsyn.1 ...

     The indexing merely outputs messages via .tm for each major page,
     section, subsection, item, and any X<> directives.

RRRREEEESSSSTTTTRRRRIIIICCCCTTTTIIIIOOOONNNNSSSS
     None at this time.

BBBBUUUUGGGGSSSS
     The =over and =back directives don't really work right.  They take
     absolute positions instead of offsets, don't nest well, and making people
     count is suboptimal in any event.

AAAAUUUUTTTTHHHHOOOORRRRSSSS
     Original prototype by Larry Wall, but so massively hacked over by Tom
     Christiansen such that Larry probably doesn't recognize it anymore.


















                                                                        PPPPaaaaggggeeee 4444






PPPPOOOODDDD2222MMMMAAAANNNN((((1111))))                                                          PPPPOOOODDDD2222MMMMAAAANNNN((((1111))))























































                                                                        PPPPaaaaggggeeee 5555